Defining enaio® coLab Object Types

enaio® coLab • 11.0 »

enaio® coLab is an application for collaborating on enaio® documents and sharing them with external users.

Before you can upload new documents to a shared folder in enaio® coLab, you first need to define a enaio® coLab register type and a enaio® coLab object type.

  1. In enaio® editor, select the cabinet in which you want to share a register or folder and right-click to open the context menu.

  2. Choose Add > Register type in the context menu.

  3. Create a mandatory string field with the internal name title and a length of 200.

    You can also add additional fields to the register type, though these will only be visible in enaio® client. These fields cannot be mandatory fields.

  4. Create a corresponding register type in each cabinet with enaio® coLab object types.

    Save your entries and close enaio® editor.

  5. Press Yes to confirm all dialogs shown after saving your changes.

  6. Add the following entry to the <enaio_installation>\service-manager\config\colab-prod.yml configuration file:

    global:
      allowed-register-types: 6488064, 6488079
    The type designations of all defined register types are specified.

  1. In enaio® editor, select the cabinet in which you want to share a register or folder and right-click to open the context menu.

  2. Choose Add > Windows Document (W) in the context menu.

    Enter a name. The internal name must begin with coLab.

  3. Create a string field with the internal name info and a length of 500.

  4. Also create a mandatory string field with the internal name title and a length of 200.

    You can also add additional fields to the object type, though these will only be visible in enaio® client. These fields cannot be mandatory fields.

  5. Save your entries and close enaio® editor.

  6. Press Yes to confirm all dialogs shown after saving your changes.

The object type for enaio® coLab has been created.

Add the enaio® coLab object type to all cabinets which you want to create project rooms from.

Next, configure the access rights for the newly created register types and object types to allow enaio® users to use them in enaio® client.

enaio® coLab periodically checks which enaio® coLab object types are present in enaio®.
The check takes place at 01:01 a.m. daily by default. The time can be changed by an entry in CRON notation in the colab-prod.yml file:
enaio:
upload-type-service-start-time: "0 1 1 * * ?"
No object types are offered if enaio® server cannot be reached at this time. In this case, restart the 'colab' service via enaio® services-admin.

Configuring the Technical User

Since enaio® coLab uses the technical user to access the DMS, you will need to configure the technical user for enaio® service-manager.

Configure the enaio® coLab technical user in the application-blue.yml file located in the <enaio_installation>\service-manager\config\ directory.

Change the following parameters in the application-blue.yml file:

enaio.dms.username: <enaio_user>
enaio.dms.password: <enaio_pw>
enaio.dms.server: enaiodms1.example.com:4000:50#enaiodms2.example.com:4000:50

All enaio® servers must be listed here.

enaio® coLab uses its own technical user to access objects in enaio®. For that reason, the access rights of users in enaio® client may differ from their access rights for the same objects in the enaio® coLab portal.

  1. Select a user group with a technical user in enaio® administrator.

  2. Select the enaio® coLab object type from the list on the left and click the arrow to move it to the right.

  3. Assign the required access rights.

  4. Save and close enaio® administrator.

  5. Launch System Configuration in Windows and open the Services tab.

  6. Select the Service Manager service and restart it.

The enaio® service-manager is restarted, and the enaio® coLab object type is created in enaio®.

To verify that the enaio® coLab object type was successfully added to the object model, open enaio® client. Navigate to the Object search area and select the cabinet where you created the enaio® coLab object type. The enaio® coLab object type should be visible in the cabinet.